Add a long description for GdkTexture
authorMatthias Clasen <mclasen@redhat.com>
Mon, 4 Dec 2017 19:04:02 +0000 (11:04 -0800)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 4 Dec 2017 19:04:02 +0000 (11:04 -0800)
gdk/gdktexture.c

index a7250d11630cd120e5b8963ecd59fd8fceb82969..69212976463187b7f86600907c4fd447d54974c2 100644 (file)
 #include "gdkinternals.h"
 #include "gdkcairo.h"
 
+/**
+ * SECTION:gdktexture
+ * @Short_description: Image data for display
+ * @Title: GdkTexture
+ *
+ * A GdkTexture represents image data that can be displayed on screen.
+ *
+ * There are various ways to create GdkTexture objects from a #GdkPixbuf
+ * or a cairo surface, or other pixel data.
+ *
+ * An important aspect of GdkTextures is that they are immutable - once
+ * the image data has been wrapped in a GdkTexture, it may be uploaded
+ * to the GPU or used in other ways that make it impractical to allow
+ * modification.
+ */
+
 /**
  * GdkTexture:
  *